Support listOf, setOf with varargs #60

passsy · 2019-01-03T19:05:50Z

The current API to create collections is rather verbose compared to kotlin. Since dart doesn't support varargs, it wasn't possible to copy Kotlins method signature.

// kotlin
listOf(1, 2, 3)

// kollection 0.3.0
listOf([1, 2, 3])

But it turned out to be a false impression of Darts capabilities. Although varargs aren't available the same API can be achieved using optional positional arguments!

// kollection 0.4.0
listOf(1, 2, 3)

To simplify things, null cannot be used as argument of listOf. Also, the number of arguments is limited to 10.
For lists with more elements and null values use the new listFrom(Iterable) method.

// kollection 0.4.0
listFrom([1, 2, 3])

Now every<type>Of(args*) function now has also a <type>From(Iterable) companion.

Additionally, as @rrousselGit pointed out, this library now offers a second way to create collections via factory constructors. Here's a complete list of all creation APIs:

void list() {
  emptyList<int>();
  listOf(1, 2, 3, 4, 5);
  listFrom([1, 2, 3, 4, 5]);

  mutableListOf(1, 2, 3, 4, 5);
  mutableListFrom([1, 2, 3, 4, 5]);

  KList<int>.empty();
  KList.of(1, 2, 3, 4, 5);
  KList.from([1, 2, 3, 4, 5]);

  KMutableList<int>.empty();
  KMutableList.of(1, 2, 3, 4, 5);
  KMutableList.from([1, 2, 3, 4, 5]);
}

void set() {
  emptySet<int>();
  setOf(1, 2, 3, 4, 5);
  setFrom([1, 2, 3, 4, 5]);

  KSet<int>.empty();
  KSet.of(1, 2, 3, 4, 5);
  KSet.from([1, 2, 3, 4, 5]);

  KHashSet<int>.empty();
  KHashSet.of(1, 2, 3, 4, 5);
  KHashSet.from([1, 2, 3, 4, 5]);

  KLinkedSet<int>.empty();
  KLinkedSet.of(1, 2, 3, 4, 5);
  KLinkedSet.from([1, 2, 3, 4, 5]);
}

void map() {
  emptyMap<int, String>();
  mapFrom({1: "a", 2: "b"});

  KMutableMap<int, String>.empty();
  KMutableMap.from({1: "a", 2: "b"});

  KHashMap<int, String>.empty();
  KHashMap.from({1: "a", 2: "b"});

  KLinkedMap<int, String>.empty();
  KLinkedMap.from({1: "a", 2: "b"});
}

This is a breaking change

This change is 100% breaking all existing implementations. But since this project is rather new (still 0.X), and not heavily used by many projects that's fine. It makes the API so much better!

Add tests
Update Readme

# Conflicts: # lib/src/collection/set.dart # lib/src/collection/set_mutable.dart # lib/src/collections.dart # test/collection/iterable_extensions_test.dart

codecov · 2019-01-03T19:08:07Z

Codecov Report

❗ No coverage uploaded for pull request base (master@6833ac7). Click here to learn what that means.
The diff coverage is 100%.

@@            Coverage Diff            @@
##             master      #60   +/-   ##
=========================================
  Coverage          ?   99.46%           
=========================================
  Files             ?       40           
  Lines             ?     1693           
  Branches          ?        0           
=========================================
  Hits              ?     1684           
  Misses            ?        9           
  Partials          ?        0

Impacted Files	Coverage Δ
lib/src/extension/map_extensions_mixin.dart	`100% <100%> (ø)`
lib/src/collection/map_linked.dart	`100% <100%> (ø)`
lib/src/k_set_hash.dart	`100% <100%> (ø)`
lib/src/util/arguments.dart	`100% <100%> (ø)`
lib/src/collection/list_empty.dart	`100% <100%> (ø)`
lib/src/extension/iterable_extension_mixin.dart	`99.57% <100%> (ø)`
lib/src/k_list_mutable.dart	`100% <100%> (ø)`
lib/src/collection/iterator.dart	`100% <100%> (ø)`
lib/src/k_set.dart	`100% <100%> (ø)`
lib/src/collection/set_hash_linked.dart	`100% <100%> (ø)`
... and 16 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 6833ac7...4b5ec0d. Read the comment docs.

rrousselGit · 2019-01-03T20:15:32Z

lib/src/collections.dart

+  } else if (arg0 != null) {
+    args = [arg0];
+  } else {
+    return emptyList();


const constructor?

KList can't offer a const constructor. See #62

This question gave me a sleepless night 😅. Thanks for asking

Glad to help. 👿
That's too bad. But in any case, since the list is immutable then always returning the same class instance even if not const, should be fine right?

I can't return KList<dynamic> for KList<String>

KList _empty = EmptyList(); KList<T> emptyList<T>() => _empty; // error: type 'EmptyList<dynamic>' is not a subtype of type 'KList<String>' emptyList<String>()

lib/src/collections.dart

Will be added in all classes in another PR

passsy added 9 commits December 31, 2018 01:18

Make listOf receive varargs and add new listFrom receiving an Iterable

6b2f0f0

Fix list order

fc9e3f0

Remove filterTo example

d6f983c

Fix list with one arg

84e21ab

Use varargs for mutableListOf and create mutableListFrom for Iterable

9df1751

Allow null as valid value in KIterator

9cee88d

Update tests

434e9c8

Merge branch 'master' into feature/vararg_creations

96fe0f7

# Conflicts: # lib/src/collection/set.dart # lib/src/collection/set_mutable.dart # lib/src/collections.dart # test/collection/iterable_extensions_test.dart

Convert all creation functions to vararg

75150bc

passsy changed the title ~~Support listOf with varargs~~ Support listOf, setOf with varargs Jan 3, 2019

passsy added the enhancement label Jan 3, 2019

Update samples

5eeb64d

rrousselGit reviewed Jan 3, 2019

View reviewed changes

passsy commented Jan 3, 2019

View reviewed changes

lib/src/collections.dart Outdated Show resolved Hide resolved

passsy mentioned this pull request Jan 4, 2019

KList should support const constructor #62

Closed

passsy and others added 14 commits January 5, 2019 00:58

Create factory constructors for a darty syntax

2f2fe17

Add tests for dart syntax

dc6a815

Add KList documentation

f19afb2

Streamline API with new types

5e58518

Fix list iteration when list contains null values

44f7377

Remove unused import

ce84416

Always call constructor directly

9d35731

Add example for all constructor types

cac72b9

Run all tests for all collection types

7b9463c

Test argsToList

f5ef9f6

Remove assertion

49aa71d

Will be added in all classes in another PR

Simplify creation syntax comparison

599500e

Update samples

306314c

Add Kollection API to readme

4b5ec0d

passsy merged commit 1b9c318 into master Jan 7, 2019

passsy deleted the feature/vararg_creations branch January 7, 2019 18:10

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support listOf, setOf with varargs #60

Support listOf, setOf with varargs #60

passsy commented Jan 3, 2019 •

edited

Loading

codecov bot commented Jan 3, 2019 •

edited

Loading

rrousselGit Jan 3, 2019

passsy Jan 4, 2019

rrousselGit Jan 4, 2019

passsy Jan 4, 2019

Support listOf, setOf with varargs #60

Support listOf, setOf with varargs #60

Conversation

passsy commented Jan 3, 2019 • edited Loading

This is a breaking change

codecov bot commented Jan 3, 2019 • edited Loading

Codecov Report

rrousselGit Jan 3, 2019

Choose a reason for hiding this comment

passsy Jan 4, 2019

Choose a reason for hiding this comment

rrousselGit Jan 4, 2019

Choose a reason for hiding this comment

passsy Jan 4, 2019

Choose a reason for hiding this comment

passsy commented Jan 3, 2019 •

edited

Loading

codecov bot commented Jan 3, 2019 •

edited

Loading